docs: fix broken intra-doc links in sdk-reference#168
Merged
Conversation
Fixes #167 zensical build --clean surfaced 19 validation warnings from stale links in docs/sdk-reference/. Root causes: - Singular vs plural filename: links pointed at steps.md, callbacks.md, child-contexts.md, but the actual files are step.md, callback.md, child-context.md. - Stale paths from an earlier reorganization: ../advanced/error-handling.md -> ../error-handling/errors.md ../../testing/basic-tests.md -> ../../testing/index.md ../getting-started.md -> ../../getting-started/index.md error-handling.md (bare) -> ../error-handling/errors.md - Anchor slug drift: retries.md linked to #retrying-specific-errors, but the heading is "Retry only specific errors", which slugifies to retry-only-specific-errors. Also align step.md's top-level heading with the filename and with the other singular operations (# Steps -> # Step). Verified with zensical build --clean: before: 19 issues found after: No issues found
wangyb-A
approved these changes
May 7, 2026
github-project-automation
Bot
moved this from In review
to Done
in aws-durable-execution
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #167.
zensical build --cleansurfaced 19 validation warnings from stale intra-doc links indocs/sdk-reference/. This PR fixes all 19 and drops the build from19 issues foundtoNo issues found.Root causes
steps.md,callbacks.md,child-contexts.md, but the actual files arestep.md,callback.md,child-context.md.../advanced/error-handling.md→../error-handling/errors.md../../testing/basic-tests.md→../../testing/index.md../getting-started.md→../../getting-started/index.mderror-handling.md(bare peer) →../error-handling/errors.mdretries.mdlinked to#retrying-specific-errors, but the heading is## Retry only specific errors, which Zensical slugifies toretry-only-specific-errors.Changes by file
sdk-reference/error-handling/retries.mdsdk-reference/observability/logging.mdsdk-reference/operations/child-context.mdsdk-reference/operations/map.mdsdk-reference/operations/parallel.mdsdk-reference/operations/step.md# Steps→# Step(align h1 with filename and the other singular operations); basic-tests.md → testing/index.mdsdk-reference/operations/wait-for-condition.mdsdk-reference/operations/wait.mdVerification